﻿/* 
   Copyright 2011 LUCA Studios LLC & John Evans

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/

namespace LUCAStudios.Silverlight.Controls.Draggable
{
    using System.Windows;

    /// <summary>
    /// A contract for elements which will participate in the Draggable service
    /// </summary>
    public interface IDraggable
    {
        /// <summary>
        /// Provides a boolean indicating whether the WindowManipulation class should honor window drag requests from the user.
        /// </summary>
        bool DragEnabled { get; }

        /// <summary>
        /// The visual element representing the drag handle of the window (usually the "chrome" or title bar)
        /// </summary>
        FrameworkElement DragHandle { get; }

        /// <summary>
        /// The visual representation of the window to perform drag/resize transformations on.
        /// </summary>
        FrameworkElement DragElement { get; }

        /// <summary>
        /// Called when drag operation completes.
        /// </summary>
        void OnDragEnded();

        /// <summary>
        /// Called just prior to when drag operation begins.
        /// </summary>
        void OnDragStarted();
    }
}
